/*-
 * SRI.java          TP-Status-Report-Indication (TP-SRI)
 *
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/SRI.java $
 *
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

import static com.googlecode.attention.util.bit.ByteBitValues.*;

/**
 * TP-Status-Report-Indication (TP-SRI).
 * <BR>
 * The TP-Status-Report-Indication is a 1-bit field, located within
 * bit no. 5 of the first octet of SMS-DELIVER, and to be given the
 * following values:
 * <BR>
 * <BR>Bit no. 5:
 * <BR><TABLE>
 * <TR><TD>0</TD><TD>A status report shall not be returned to the SME</TD></TR>
 * <TR><TD>1</TD><TD>A status report shall be returned to the SME</TD></TR>
 * </TABLE>
 * 
 * @author Stein Gunnar Bakkeby
 */
public enum SRI {

  /** A status report shall not be returned to the SME. */
  NOT_INDICATED(0),
  /** A status report shall be returned to the SME. */
  INDICATED(B5);
  
  /** Binary value of the SRI. */
  public final int value;
  
  private SRI(final int value) {
    this.value = value;
  }
  
  /**
   * This will return the correct SRI enum based on the integer passed in.
   * 
   * @param value Can be bit 7 of the first octet, or the first octet itself
   * @return The corresponding SRI enum
   */
  public static SRI parse(int value) {
    value &= B5;
    switch (value) {
    case B5:
      return INDICATED;
    case 0:
    default:
      return NOT_INDICATED;
    }
  }
}